Workshop Swagger et OpenAPI

package com.sqli.pbousquet.testapi.api;

[...]

@RestController
@RequestMapping({"/api/v1/hello"})
public class HelloAPI {

    private static final Logger LOGGER = LoggerFactory.getLogger(HelloAPI.class);

    @GetMapping
    public ResponseEntity<HelloDto> hello() {
        LOGGER.info("GET /api/v1/hello");
        return hello(null);
    }

    @GetMapping(path = "/{name}")
    public ResponseEntity<HelloDto> hello(@PathVariable String name) {
        if (name != null) LOGGER.info("GET /api/v1/hello/"+name);
        HelloDto result = new HelloDto();
        result.setMessage("Hello World");
        if (name != null) {
            if ("123".equals(name)) {
                return ResponseEntity.badRequest().build();
            }
            result.setMessage("Hello " + name);
        }
        LOGGER.info("Response : "+result.getMessage());
        return ResponseEntity.ok(result);
    }
}

	<dependencies>
    [...]
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-common</artifactId>
			<version>2.9.2</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.9.2</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-bean-validators</artifactId>
			<version>2.9.2</version>
		</dependency>
	</dependencies>

package com.sqli.pbousquet.testapi.config;

[...]

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    [...]

    @Bean
    public Docket api(ServletContext servletContext) {
        return new Docket(DocumentationType.SPRING_WEB)
                .pathProvider(new RelativePathProvider(servletContext) {
                    @Override
                    public String getApplicationBasePath() {
                        return basePath;
                    }
                })
                .apiInfo(DEFAULT_API_INFO)
                .produces(DEFAULT_PRODUCES_AND_CONSUMES)
                .consumes(DEFAULT_PRODUCES_AND_CONSUMES)
                .select().paths(PathSelectors.ant("/api/**")).build();
    }

}

    @Bean
    public Docket api(ServletContext servletContext) {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathProvider(new RelativePathProvider(servletContext) {
                    @Override
                    public String getApplicationBasePath() {
                        return basePath;
                    }
                })
                .apiInfo(DEFAULT_API_INFO)
                .produces(DEFAULT_PRODUCES_AND_CONSUMES)
                .consumes(DEFAULT_PRODUCES_AND_CONSUMES)
                .select().paths(PathSelectors.ant("/api/**")).build();
    }

    @GetMapping(path = "/{name}")
    @ApiOperation(value = "Saluer une personne en particulier",
        response = HelloDto.class, position = 1)
    @ApiResponses({
            @ApiResponse(code = 200, message = "OK"),
            @ApiResponse(code = 400, message = "Mauvaise requête,
                123 n'est pas une valeurs valide")
    })
    public ResponseEntity<HelloDto> hello(@ApiParam(required = true,
        name = "name", value = "Nom de la personne à saluer")
        @PathVariable String name) {

        if (name != null) LOGGER.info("GET /api/v1/hello/"+name);
        HelloDto result = new HelloDto();
[...]
    }

<plugin>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-maven-plugin</artifactId>
    <version>4.1.0</version>
    <executions>
[...]
    </executions>
</plugin>

<execution>
    <id>1</id>
    <goals>
        <goal>generate</goal>
    </goals>
    <configuration>
        <inputSpec>${project.basedir}/contracts/producer/hello.yaml</inputSpec>
        <generatorName>spring</generatorName>
        <library>spring-mvc</library>
        <templateDirectory>templates/producer/spring</templateDirectory>
        <generateApiTests>false</generateApiTests>
        <generateModelTests>false</generateModelTests>
        <generateSupportingFiles>true</generateSupportingFiles>
        <configOptions>
            <useTags>true</useTags>
            <sourceFolder>src/main/java</sourceFolder>
            <dateLibrary>java7</dateLibrary>
            <java8>true</java8>
            <interfaceOnly>true</interfaceOnly>
            <hideGenerationTimestamp>false</hideGenerationTimestamp>
        </configOptions>
        <apiPackage>com.sqli.pbousquet.testapi.api</apiPackage>
        <modelPackage>com.sqli.pbousquet.testapi.dto</modelPackage>
    </configuration>
</execution>

package com.sqli.pbousquet.testapi.api.impl;

import com.sqli.pbousquet.testapi.dto.HelloDto;
import io.swagger.annotations.Api;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Api(value = "Hello", description = "the Hello API", tags = {"hello"})
public class HelloApiImpl implements com.sqli.pbousquet.testapi.api.HelloApi {

    @Override
    public ResponseEntity<HelloDto> helloUsingGET1() {
        HelloDto result = new HelloDto();
        result.setMessage("Hello World");
        return ResponseEntity.ok(result);
    }

    @Override
    public ResponseEntity<HelloDto> helloUsingGET(String name) {
        HelloDto result = new HelloDto();
        result.setMessage("Hello "+name);
        return ResponseEntity.ok(result);
    }
}